<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - Metrics</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Investor.html">Investor</a></li>
	
	<li><a href="../symbols/Localizer.html">Localizer</a></li>
	
	<li><a href="../symbols/Metrics.html">Metrics</a></li>
	
	<li><a href="../symbols/Notification.html">Notification</a></li>
	
	<li><a href="../symbols/Options.html">Options</a></li>
	
	<li><a href="../symbols/Popup.html">Popup</a></li>
	
	<li><a href="../symbols/Portfolio.html">Portfolio</a></li>
	
	<li><a href="../symbols/Quote.html">Quote</a></li>
	
	<li><a href="../symbols/Settings.html">Settings</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class Metrics
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/chromequotes_src_script_class__Metrics.js.html">Metrics.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Metrics.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/Metrics.html#constructor">Metrics</a></b>()
							</div>
							<div class="description">This class contains the metrics available for use in returning values for
the security IDs chosen</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Metrics.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Metrics.html#-$div">$div</a></b>
								</div>
								<div class="description">A private member containing a jQuery-wrapped DIV node</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Metrics.html#-columns">columns</a></b>
								</div>
								<div class="description">A private array holding the metrics chosen for use</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Metrics.html#-metrics">metrics</a></b>
								</div>
								<div class="description">A private object holding the metrics available for use</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Metrics.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.add">add</a></b>(label, type, func, numer, denom)
								</div>
								<div class="description">Adds a new metric to the Metrics object</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.calculate">calculate</a></b>(label, context)
								</div>
								<div class="description">Evaluates a metric for the supplied context</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.column">column</a></b>(index)
								</div>
								<div class="description">Retrieves the metric assigned to a particular column</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.count">count</a></b>()
								</div>
								<div class="description">Retrieves the number of metrics in use</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.dropdowns">dropdowns</a></b>($node)
								</div>
								<div class="description">Creates a dropdown of available for metrics for selection on the options
page</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.get">get</a></b>(label)
								</div>
								<div class="description">Retrieves a metric based on its corresponding label</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.load">load</a></b>()
								</div>
								<div class="description">Loads the values for the metrics in use from local storage</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.reset">reset</a></b>()
								</div>
								<div class="description">Resets the metrics in use to their defaults</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Metrics.<b><a href="../symbols/Metrics.html#.save">save</a></b>()
								</div>
								<div class="description">Saves the metrics based on selections made on the options page</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>Metrics</b>()
				</div>
				
				<div class="description">
					This class contains the metrics available for use in returning values for
the security IDs chosen
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name="-$div"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{Object}</span>
					<b>$div</b>
					
					</div>
					<div class="description">
						A private member containing a jQuery-wrapped DIV node
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="-columns"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{Object}</span>
					<b>columns</b>
					
					</div>
					<div class="description">
						A private array holding the metrics chosen for use
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="-metrics"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{Object}</span>
					<b>metrics</b>
					
					</div>
					<div class="description">
						A private object holding the metrics available for use
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".add"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Metrics.html">Metrics</a>}</span>
					<span class="light">Metrics.</span><b>add</b>(label, type, func, numer, denom)
					
					</div>
					<div class="description">
						Adds a new metric to the Metrics object
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>label</b>
									
								</dt>
								<dd>The label which will be used when localizing the
name of the parameter</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>type</b>
									
								</dt>
								<dd>The type of value (text, value, change, pct)</dd>
							
								<dt>
									<span class="light fixedFont">{function}</span> <b>func</b>
									
								</dt>
								<dd>The function for evaluating the sum of all values</dd>
							
								<dt>
									<span class="light fixedFont">{function}</span> <b>numer</b>
									
								</dt>
								<dd>The function for evaluating the numerator</dd>
							
								<dt>
									<span class="light fixedFont">{function}</span> <b>denom</b>
									
								</dt>
								<dd>The function for evaluating the denominator</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".calculate"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{number}</span>
					<span class="light">Metrics.</span><b>calculate</b>(label, context)
					
					</div>
					<div class="description">
						Evaluates a metric for the supplied context
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>label</b>
									
								</dt>
								<dd>The metric's label</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>context</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd></dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".column"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Object}</span>
					<span class="light">Metrics.</span><b>column</b>(index)
					
					</div>
					<div class="description">
						Retrieves the metric assigned to a particular column
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>index</b>
									
								</dt>
								<dd>The index of the column</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>A metric and its associated functions</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".count"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{number}</span>
					<span class="light">Metrics.</span><b>count</b>()
					
					</div>
					<div class="description">
						Retrieves the number of metrics in use
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The number of metrics in use</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".dropdowns"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Metrics.html">Metrics</a>}</span>
					<span class="light">Metrics.</span><b>dropdowns</b>($node)
					
					</div>
					<div class="description">
						Creates a dropdown of available for metrics for selection on the options
page
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>$node</b>
									
								</dt>
								<dd>The jQuery-wrapped DOM node that will contain this
method's output</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".get"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{object}</span>
					<span class="light">Metrics.</span><b>get</b>(label)
					
					</div>
					<div class="description">
						Retrieves a metric based on its corresponding label
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>label</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>A metric</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".load"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Metrics.html">Metrics</a>}</span>
					<span class="light">Metrics.</span><b>load</b>()
					
					</div>
					<div class="description">
						Loads the values for the metrics in use from local storage
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".reset"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Metrics.html">Metrics</a>}</span>
					<span class="light">Metrics.</span><b>reset</b>()
					
					</div>
					<div class="description">
						Resets the metrics in use to their defaults
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".save"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Metrics.html">Metrics</a>}</span>
					<span class="light">Metrics.</span><b>save</b>()
					
					</div>
					<div class="description">
						Saves the metrics based on selections made on the options page
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Fri Feb 18 2011 03:34:35 GMT+0900 (JST)
		</div>
	</body>
</html>
